home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / program / depend.zip / README.TXT < prev   
Text File  |  1996-07-20  |  6KB  |  155 lines
  1.  
  2. Copyright (C) 1996 by Jim Wakeen.  All rights reserved.
  3.  
  4. This software was developed by Jim Wakeen. Permission to use, copy, modify,
  5. and distribute this software for any purpose is hereby granted without fee,
  6. provided that the above copyright notice and this notice accompany all
  7. copies, and that the name of the author not be used in advertising or
  8. publicity pertaining to distribution of the software without specific, written
  9. prior permission.
  10.  
  11. THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
  12. WARRANTY.  IN PARTICULAR, THE AUTHOR MAKES NO REPRESENTATION OR WARRANTY OF
  13. ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR
  14. ANY PARTICULAR PURPOSE.
  15.  
  16.                             *** USAGE NOTES ***
  17.  
  18. depend.exe will generate dependency lists for C/C++ source files that can be
  19. inserted directly into a makefile.  This readme provides more information
  20. about the options.
  21.  
  22. usage:
  23.     depend [-options] files...
  24.  
  25. Note:  all options must be separated by a space from their following arguments.
  26.  
  27. Options:
  28.  
  29.     -1        Output one dependency per line
  30.  
  31.       Most makefiles are simpler to interpret if there is only one dependency
  32.       per line.  This is exactly what this option does.  Here are 2 runs of
  33.       the same file with and without the -1 option.  Use whichever format you
  34.       perfer.
  35.  
  36.       C:\src\depend>depend string.cpp
  37.       string.obj: string.cpp string.hpp forcelib.h
  38.  
  39.  
  40.       C:\src\depend>depend -1 string.cpp
  41.       string.obj: \
  42.               string.cpp \
  43.               string.hpp \
  44.               forcelib.h
  45.  
  46. ///////////////////////////////////////////////////////////////////////////////
  47.  
  48.     -d        Display dependency tree listing
  49.  
  50.       Since depend uses a recursive algorithm to depend in each dependant
  51.       file, it is sometimes valuable for debugging purposes to see which
  52.       level a file was included at.  Each level in indented by a tab char and
  53.       is written to stderr, so to capture it in a file you'll have to
  54.       re-route the stderr to a file.  I don't know how to capture the stderr
  55.       in dos.  In NT you can use
  56.       
  57.          depend (args) > outfile 2>&1
  58.  
  59.       to connect the stdout and stderr and throw the whole mess into outfile.
  60.       Here is a sample run:
  61.  
  62.       C:\winproj\petools>depend -d date.cpp
  63.       date.cpp
  64.               petools.h
  65.                       peassert.h
  66.               date.h
  67.       date.cpp[4]
  68.       date.obj: date.cpp petools.h peassert.h date.h
  69.  
  70.       This output says that date.cpp depends on (includes) petools.h and
  71.       date.h.  petools.h depends on (includes) peasert.h.  Notice that
  72.       petools.h and date.h are both indented at the same level. [4] means
  73.       date.cpp is dependant on a total of 4 files.
  74.  
  75. ///////////////////////////////////////////////////////////////////////////////
  76.  
  77.     -ex @file Specify files to ignore in file
  78.  
  79.       Use this option to name a file that contains include files to exclude
  80.       from a dependency list.  MSDev v2.* uses a file named sysincl.dat.  The
  81.       format of the exclude file is one file per line and the exclude file
  82.       must be either in the current directory or be named with an absolute
  83.       (full) path.  For example:
  84.  
  85.       depend -ex @\msdev\bin\sysincl.dat date.cpp
  86.  
  87. ///////////////////////////////////////////////////////////////////////////////
  88.  
  89.     -i  path  Add path to include search
  90.  
  91.       Use this option to add includes to the list of directories to search to
  92.       find included files.   This path can be relative or absolute.  This is
  93.       the same as the compiler option.  The INCLUDE environment variable is
  94.       checked after all of these included directories are checked and the file
  95.       being sought is not found.  For example:
  96.  
  97.       depend -i ..\include -i ..\packages date.cpp
  98.  
  99. ///////////////////////////////////////////////////////////////////////////////
  100.  
  101.     -o  file  Write output to file
  102.  
  103.       Use the option to save the output into file.  The same thing can be done
  104.       with redirection.
  105.  
  106. ///////////////////////////////////////////////////////////////////////////////
  107.  
  108.     -oe file  Write output and errors to file
  109.  
  110.       Use the option to save the output and any errors into file.  The same
  111.       thing can be done with redirection as in the -d option description.
  112.  
  113. ///////////////////////////////////////////////////////////////////////////////
  114.  
  115.     -s        Scan system includes (files included with <...> form)
  116.  
  117.       Normally, you don't want to include files from the standard C/C++
  118.       library in you dependency lists since you shouldn't be changing these
  119.       very often!  If for some reason you want to see how these files fit into
  120.       the dependency scheme, you can search them by turning on this option.
  121.  
  122. ///////////////////////////////////////////////////////////////////////////////
  123.  
  124.     -v        Display extra dependency and search information (verbose)
  125.  
  126.       This option display where it is searching for a file when it finds an
  127.       included file.  This output is helpful when you have 2 files identically
  128.       named and want to be sure one is being included and one is not.  For
  129.       example, here is a sample run:
  130.  
  131.       C:\winproj\pedb>depend -v -i ..\petools unititr.cpp
  132.       Searching for 'unititr.cpp' in:
  133.       Searching for 'peassert.h' in:
  134.               peassert.h
  135.               ..\petools\peassert.h
  136.       Searching for 'ts3iox.h' in:
  137.               ts3iox.h
  138.               ..\petools\ts3iox.h
  139.               c:\msdev\include\ts3iox.h
  140.               c:\msdev\mfc\include\ts3iox.h
  141.  
  142.       ts3iox.h:  file not found
  143.       Searching for 'unitkey.h' in:
  144.               unitkey.h
  145.       Searching for 'key.h' in:
  146.               key.h
  147.       unititr.obj: unititr.cpp pedbstd.h ..\petools\peassert.h ts3iox.h unitkey.h
  148.  
  149.       The last file in the searching for ... output is the one that was
  150.       found. Notice that in this example the file ts3iox.h was not found.  (I
  151.       intentionally did not add ..\include to the search path to show this
  152.       eror).  This gives you an idea of where the generator looked for the
  153.       includes as it found them.  
  154.  
  155.